<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>Point (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>

  <script type="text/javascript" src="//www.google.com/jsapi"></script>
  <script type="text/javascript">
     google.load("visualization", "1", {packages:["orgchart"]});
     var _loadingVisualizations = true;
  </script>

  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
        <span class="fn">editor.range.Point</span>
        <span>Extends</span>
        <span class="fn-name">
          
        </span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    One endpoint of a range, represented as a Node and and offset.

  </div>


        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="local_closure_goog_editor_range.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/editor/range.js">Git</a></li>
          </ol>
        </div>
</div>






<h2 class="g-first">Inheritance</h2>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
  <tr><td>goog.editor.range.Point</td><td></td></tr>
</table>
</div>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
</table>
</div>




  <h2>Constructor</h2>
      <div class="fn-constructor">
    goog.editor.range.Point(<span><span class="arg">node</span>,&nbsp;<span class="arg">offset</span></span>)
  </div>

   <h3>Parameters</h3>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">node</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
        <div class="entryOverview">The node containing the point.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">offset</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
        <div class="entryOverview">The offset of the point into the node.</div>
     </td>
   </tr>
  </table>


<h2>Instance Methods</h2>


  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_editor_range_Point.html">
              goog.editor.range.Point
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.editor.range.Point.prototype.getParentPoint"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getParentPoint<span class="args">()</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="class_goog_editor_range_Point.html">goog.editor.range.Point</a></span>
      </div>


     <div class="entryOverview">
       Gets the point of this point's node in the DOM.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="class_goog_editor_range_Point.html">goog.editor.range.Point</a></span>&nbsp;
            The node's point.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_editor_range.js.source.html#line491">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Instance Properties</h2>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_editor_range_Point.html">
              goog.editor.range.Point
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.editor.range.Point.prototype.node"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">node</span>
        : 
     </div>


     <div class="entryOverview">
       The node containing the point.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_editor_range.js.source.html#line477">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.editor.range.Point.prototype.offset"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">offset</span>
        : 
     </div>


     <div class="entryOverview">
       The offset of the point into the node.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_editor_range.js.source.html#line483">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Static Methods</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.editor.range.Point.createDeepestPoint"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.range.Point.</span><span class="entryName">createDeepestPoint<span class="args">(<span class="arg">node</span>,&nbsp;<span class="arg">offset</span>,&nbsp;<span class="arg">opt_trendLeft</span>,&nbsp;<span class="arg">opt_stopOnChildlessElement</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="class_goog_editor_range_Point.html">goog.editor.range.Point</a></span>
      </div>


     <div class="entryOverview">
       Construct the deepest possible point in the DOM that's equivalent
to the given point, expressed as a node and an offset.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">node</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
        <div class="entryOverview">The node containing the point.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">offset</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
        <div class="entryOverview">The offset of the point from the node.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_trendLeft</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Notice that a (node, offset) pair may be
    equivalent to more than one descendent (node, offset) pair in the DOM.
    By default, we trend rightward. If this parameter is true, then we
    trend leftward. The tendency to fall rightward by default is for
    consistency with other range APIs (like placeCursorNextTo).</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_stopOnChildlessElement</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">If true, and we encounter
    a Node which is an Element that cannot have children, we return a Point
    based on its parent rather than that Node itself.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="class_goog_editor_range_Point.html">goog.editor.range.Point</a></span>&nbsp;
            A new point.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_editor_range.js.source.html#line513">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.editor.range.Point.getPointAtEndOfNode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.range.Point.</span><span class="entryName">getPointAtEndOfNode<span class="args">(<span class="arg">node</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="class_goog_editor_range_Point.html">goog.editor.range.Point</a></span>
      </div>


     <div class="entryOverview">
       Construct a point at the very end of the given node.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">node</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
        <div class="entryOverview">The node to create a point for.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="class_goog_editor_range_Point.html">goog.editor.range.Point</a></span>&nbsp;
            A new point.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_editor_range.js.source.html#line570">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.editor.range.Point.isTerminalElement_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.range.Point.</span><span class="entryName">isTerminalElement_<span class="args">(<span class="arg">node</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Return true if the specified node is an Element that is not expected to have
children. The createDeepestPoint() method should not traverse into
such elements.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">node</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
        <div class="entryOverview">.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            True if the node is an Element that does not contain
    child nodes (e.g. BR, IMG).
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_editor_range.js.source.html#line559">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package editor.range</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="" current="editor.range.Point"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
